<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Sub::Util - A selection of utility subroutines for subs and CODE references - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/Sub::Util">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Sub::Util.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/Sub::Util">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/Sub::Util">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/Sub::Util">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/Sub::Util">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/Sub::Util">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/Sub::Util">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/Sub::Util">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/Sub::Util">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/Sub::Util">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/Sub::Util">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/Sub::Util">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/Sub::Util">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/Sub::Util">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/Sub::Util">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/Sub::Util">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/Sub::Util">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/Sub::Util">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/Sub::Util">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/Sub::Util">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/Sub::Util">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/Sub::Util">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/Sub::Util">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/Sub::Util">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/Sub::Util">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/Sub::Util">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/Sub::Util">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/Sub::Util">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/Sub::Util">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/Sub::Util">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/Sub::Util">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/Sub::Util">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/Sub::Util">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/Sub::Util">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/Sub::Util">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/Sub::Util">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/Sub::Util">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/Sub::Util">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/Sub::Util">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/Sub::Util">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/Sub::Util">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/Sub::Util">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/Sub::Util">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/Sub::Util">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/Sub::Util">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/Sub::Util">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/Sub::Util">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/Sub::Util">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/Sub::Util">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/Sub::Util">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/Sub::Util">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/Sub::Util">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/Sub::Util">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/Sub::Util">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/Sub::Util">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/Sub::Util">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/Sub::Util">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/Sub::Util">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/Sub::Util">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/Sub::Util">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/Sub::Util">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/Sub::Util">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/Sub::Util">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/Sub::Util">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/Sub::Util">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/Sub::Util">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/Sub::Util">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/Sub::Util">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/Sub::Util">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/Sub::Util">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/Sub::Util">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/Sub::Util">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/Sub::Util">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/Sub::Util">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/Sub::Util">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/Sub::Util">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/Sub::Util">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/Sub::Util">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/Sub::Util">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/Sub::Util">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/Sub::Util">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Sub::Util.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/Sub::Util">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/Sub::Util">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/Sub::Util">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/Sub::Util">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/Sub::Util">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/Sub::Util">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/Sub::Util">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/Sub::Util">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/Sub::Util">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/Sub::Util">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/Sub::Util">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/Sub::Util">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/Sub::Util">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/Sub::Util">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/Sub::Util">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/Sub::Util">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/Sub::Util">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/Sub::Util">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/Sub::Util">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/Sub::Util">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/Sub::Util">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/Sub::Util">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/Sub::Util">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/Sub::Util">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/Sub::Util">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/Sub::Util">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/Sub::Util">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/Sub::Util">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/Sub::Util">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/Sub::Util">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/Sub::Util">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/Sub::Util">5.35.1</a>
          <a class="dropdown-item active" href="./Sub::Util.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Sub::Util.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./Sub::Util.html">Sub::Util</a>
          <div id="more">
            (<a href="./Sub::Util.txt">source</a>,
            <a href="https://metacpan.org/pod/Sub::Util">CPAN</a>)
          </div>
            <div id="moduleversion">version 1.55</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#FUNCTIONS">FUNCTIONS</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#prototype">prototype</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#set_prototype">set_prototype</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#subname">subname</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#set_subname">set_subname</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Sub::Util.html#AUTHOR">AUTHOR</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./Sub::Util.html#NAME">#</a>NAME</h1>

<p>Sub::Util - A selection of utility subroutines for subs and CODE references</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./Sub::Util.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>use Sub::Util qw( prototype set_prototype subname set_subname );</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="./Sub::Util.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p><code>Sub::Util</code> contains a selection of utility subroutines that are useful for operating on subs and CODE references.</p>

<p>The rationale for inclusion in this module is that the function performs some work for which an XS implementation is essential because it cannot be implemented in Pure Perl, and which is sufficiently-widely used across CPAN that its popularity warrants inclusion in a core module, which this is.</p>

<h1 id="FUNCTIONS"><a class="permalink" href="./Sub::Util.html#FUNCTIONS">#</a>FUNCTIONS</h1>

<h2 id="prototype"><a class="permalink" href="./Sub::Util.html#prototype">#</a>prototype</h2>

<pre><code>my $proto = prototype( $code )</code></pre>

<p><i>Since version 1.40.</i></p>

<p>Returns the prototype of the given <code>$code</code> reference, if it has one, as a string. This is the same as the <code>CORE::prototype</code> operator; it is included here simply for symmetry and completeness with the other functions.</p>

<h2 id="set_prototype"><a class="permalink" href="./Sub::Util.html#set_prototype">#</a>set_prototype</h2>

<pre><code>my $code = set_prototype $prototype, $code;</code></pre>

<p><i>Since version 1.40.</i></p>

<p>Sets the prototype of the function given by the <code>$code</code> reference, or deletes it if <code>$prototype</code> is <code>undef</code>. Returns the <code>$code</code> reference itself.</p>

<p><i>Caution</i>: This function takes arguments in a different order to the previous copy of the code from <code>Scalar::Util</code>. This is to match the order of <code>set_subname</code>, and other potential additions in this file. This order has been chosen as it allows a neat and simple chaining of other <code>Sub::Util::set_*</code> functions as might become available, such as:</p>

<pre><code>my $code =
   set_subname   name_here =&gt;
   set_prototype &#39;&amp;@&#39;      =&gt;
   set_attribute &#39;:lvalue&#39; =&gt;
      sub { ...... };</code></pre>

<h2 id="subname"><a class="permalink" href="./Sub::Util.html#subname">#</a>subname</h2>

<pre><code>my $name = subname( $code )</code></pre>

<p><i>Since version 1.40.</i></p>

<p>Returns the name of the given <code>$code</code> reference, if it has one. Normal named subs will give a fully-qualified name consisting of the package and the localname separated by <code>::</code>. Anonymous code references will give <code>__ANON__</code> as the localname. If the package the code was compiled in has been deleted (e.g. using <code>delete_package</code> from <a href="Symbol.html">Symbol</a>), <code>__ANON__</code> will be returned as the package name. If a name has been set using <a href="./Sub::Util.html#set_subname">&quot;set_subname&quot;</a>, this name will be returned instead.</p>

<p>This function was inspired by <code>sub_fullname</code> from <a href="./Sub::Identify.html">Sub::Identify</a>. The remaining functions that <code>Sub::Identify</code> implements can easily be emulated using regexp operations, such as</p>

<pre><code>sub get_code_info { return (subname $_[0]) =~ m/^(.+)::(.*?)$/ }
sub sub_name      { return (get_code_info $_[0])[0] }
sub stash_name    { return (get_code_info $_[0])[1] }</code></pre>

<p><i>Users of Sub::Name beware</i>: This function is <b>not</b> the same as <code>Sub::Name::subname</code>; it returns the existing name of the sub rather than changing it. To set or change a name, see instead <a href="./Sub::Util.html#set_subname">&quot;set_subname&quot;</a>.</p>

<h2 id="set_subname"><a class="permalink" href="./Sub::Util.html#set_subname">#</a>set_subname</h2>

<pre><code>my $code = set_subname $name, $code;</code></pre>

<p><i>Since version 1.40.</i></p>

<p>Sets the name of the function given by the <code>$code</code> reference. Returns the <code>$code</code> reference itself. If the <code>$name</code> is unqualified, the package of the caller is used to qualify it.</p>

<p>This is useful for applying names to anonymous CODE references so that stack traces and similar situations, to give a useful name rather than having the default of <code>__ANON__</code>. Note that this name is only used for this situation; the <code>set_subname</code> will not install it into the symbol table; you will have to do that yourself if required.</p>

<p>However, since the name is not used by perl except as the return value of <code>caller</code>, for stack traces or similar, there is no actual requirement that the name be syntactically valid as a perl function name. This could be used to attach extra information that could be useful in debugging stack traces.</p>

<p>This function was copied from <code>Sub::Name::subname</code> and renamed to the naming convention of this module.</p>

<h1 id="AUTHOR"><a class="permalink" href="./Sub::Util.html#AUTHOR">#</a>AUTHOR</h1>

<p>The general structure of this module was written by Paul Evans &lt;leonerd@leonerd.org.uk&gt;.</p>

<p>The XS implementation of <a href="./Sub::Util.html#set_subname">&quot;set_subname&quot;</a> was copied from <a href="./Sub::Name.html">Sub::Name</a> by Matthijs van Duin &lt;xmath@cpan.org&gt;</p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
